Fix broken KDoc links #254
Conversation
This is mainly to avoid the warning on compilation of stubs in Kotlin.
alexander-yevsyukov
requested review from
Copilot
and removed request for
Copilot
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
There was a problem hiding this comment.
Pull request overview
This PR fixes broken KDoc links in the ErrorPlaceholder class that prevented successful documentation publishing with Dokka. The links could not be resolved because the context module lacks a dependency on the runtime module.
Key changes:
- Removed unresolvable KDoc
@seereferences to runtime module classes - Added backward compatibility interface for
FieldAwareMessageto prevent Kotlin compilation warnings - Updated version to 2.0.0-SNAPSHOT.381
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| context/src/main/kotlin/io/spine/tools/validation/ErrorPlaceholder.kt | Removed @see tags referencing classes in the runtime module to fix broken KDoc links |
| jvm-runtime/src/main/java/io/spine/validate/FieldAwareMessage.java | Added deprecated interface for backward compatibility during migration to io.spine.validation |
| version.gradle.kts | Version bump to 2.0.0-SNAPSHOT.381 |
| pom.xml | Version bump to 2.0.0-SNAPSHOT.381 |
| dependencies.md | Auto-generated dependency report with updated timestamps and version references |
| config | Updated subproject commit reference |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
context/src/main/kotlin/io/spine/tools/validation/ErrorPlaceholder.kt
Outdated
Show resolved
Hide resolved
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #254 +/- ##
=========================================
Coverage 34.92% 34.92%
Complexity 276 276
=========================================
Files 137 137
Lines 3055 3055
Branches 244 244
=========================================
Hits 1067 1067
Misses 1914 1914
Partials 74 74 🚀 New features to boost your workflow:
|
armiol
left a comment
armiol
left a comment
There was a problem hiding this comment.
LGTM.
JFYI.
Previously, I have reproduced the past error locally, and now I have checked the publishing again, and it works fine.
This PR fixes the documentation links in the
ErrorPlaceholderclass which could not be resolved by Dokka because thecontextmodules does not have dependency on theruntimemodule. This caused the error when publishing.Other notable changes
io.spine.validate.FieldAwareMessageinterface for backward compatibility during the transition toio.spine.validation. The absence of the interface cased strict warnings during compilation of stubs in Kotlin.